Documentation Powered by ReDoc

Spot by NetApp API

Download OpenAPI specification:Download

E-mail: support@spot.io

Welcome to the Spot by NetApp OpenAPI Specification. Here you will find REST definitions for all Spot products and platform administration tasks.

The API is hosted at https://api.spotinst.io and requires Bearer Token Authentication.

For more information on how to use the Spot platform, including user guides, developer guides, concepts and tutorials see the external Spot Help documentation.

https://help.spot.io/

Authentication

SpotAuth

To generate bearer tokens and understand more about Spot by NetApp authentication see the howto for token creation on the Spot Help site.

Organization And Accounts

Each Spot account is assigned to an organization and a set of environment Accounts. An account is then linked to a specific cloud provider account.

Spot accounts are given an ID in the format act-123abcd that is sent as a query parameter while performing API calls.

To locate the account ID navigate to Settings -> Account in the Spot console.

Organizations With A Single Account

Each API call you make can be used with or without the account ID.

Organizations With Multiple Accounts Each API call you make should be appended to the account ID. For example:

GET https://api.spotinst.io/aws/ec2/group?accountId=act-123de678 This call will return the list of Elastigroups for the specific Account used.

Please note – If no accountId is provided, the default (Oldest) account for the Organization will be used

Security Scheme Type HTTP
HTTP Authorization Scheme bearer

Ocean AWS

Ocean - Serverless containers for Amazon Web Services (AWS)

Ocean for AWS Concepts and Tutorials

Ocean AWS - Create

Prerequisites

The Spot Controller is used to monitor the cluster resources and report back to Ocean and is required for Ocean On-Prem.

To install the Spot Controller, complete and run the following script on a machine with kubectl command line tool installed and configured:

#!/usr/bin/env bash
curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
bash
Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object (auto-scaler)

The Ocean Kubernetes Autoscaler.

object (Capacity Units)

Capacity specifications for the Ocean cluster.

object (Ocean Compute)
controllerClusterId
required
string

Enter the Ocean cluster identifier.

name
required
string

Add a name for the Ocean cluster.

region
required
string

Select the region for the Ocean cluster to run in.

object (Elastigroup Scheduling)
object (Security)
object (Ocean Cluster Strategy)

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - List

List the configurations for all Ocean cluster in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Delete

Delete a specified Ocean cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Get

Get the configurations for a specified Ocean cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Update

All Ocean parameters are updatable, except for region and ID. This API supports partial updates, so specific fields can be updated separately.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

autoApplyTags
string
Example: autoApplyTags=true

Optionally update instance tags on the fly without rolling the cluster.

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
required
object (AWS Cluster)
group
object

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    },
  • "group": { }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Get Heartbeat Status

Get Ocean cluster’s controller heartbeat status.
The response would return the heartbeat status and last heartbeat timestamp."

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
Authorization
string
content-Type
string

Responses

Request samples

Content type
application/json
{
  • "content-Type": "application/json",
  • "Authorization": "Bearer ${token}"
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Import ASG To Ocean Cluster

Create an Ocean configuration according to an AWS autoscaling group (ASG) configuration.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

autoScalingGroupName
required
string

The autoscaling group name.

region
required
string
Example: region=us-east-1

Region name of the ASG.

Responses

Response samples

Content type
application/json
{
  • "name": "TestASG1",
  • "controllerClusterId": "ocean-ed609402-8557-4d18-818a-e549333cc11e",
  • "region": "us-west-2",
  • "capacity":
    {
    },
  • "compute":
    {
    }
}

Ocean AWS - Filter Right-Sizing Recommendations

Get right-sizing recommendations for an Ocean cluster and filter them according to namespace or label.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
object

An object enabling filtering of right-size recommendations. Optional; may be null.

object
namespaces
array of string

A list of Kubernetes namespaces to filter by. Optional; may be null. If it exists, must contain at least one item.

Responses

Request samples

Content type
application/json
{
  • "filter":
    {
    }
}

Response samples

Content type
application/json
{
  • "items":
    [
    ]
}

Ocean AWS - Ocean Kubernetes Cluster Costs

Describes Kubernetes cluster costs in a time range based on resource allocation. The response will provide the distribution of the costs per cluster, namespace, and deployment. For each entity, the response will contain breakdown to compute and EBS costs as well. In addition, response will show labels/annotations for each namespace or deployment so you can filter costs by labels or annotations.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

aggregationPeriod
string

Possible values: "daily", null. For daily value response contains aggregated data by day.
If null - response returns sum of costs per period

fromDate
required
string

data values following either a date format (yyyy-mm-dd ; 2016-11-20) or ms (1494751821472)

toDate
required
string

data values following either a date format (yyyy-mm-dd ; 2016-11-20) or ms (1494751821472)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Upgrade Elastigroup To Ocean

Upgrade an Elastigroup with K8s integration into Ocean for K8s cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

groupId
required
string

Elastigroup ID

Responses

Response samples

Content type
application/json
{
  • "kind": "spotinst:ocean:aws:k8s",
  • "items":
    {
    }
}

Ocean AWS - Initiate roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately, by defined batches. Note that the first response for a successful request will notify for starting a roll. In order to check the status of a roll, you can use the GET Roll API.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
object

Settings for roll operation

batchSizePercentage
integer

Value in % to set size of batch in roll. Valid values are 0-100

comment
string

Add a comment description for the roll. comment should be limit to 256 chars.

instanceIds
array of string

List of instance IDs to be rolled. Each ID is a string. instanceIds can be null. Cannot be used together with launchSpecIds.

launchSpecIds
array of string

List of launch specification IDs to be rolled. Each ID is a string. launchSpecIds can be null. Cannot be used together with instanceIds.

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "id": "scr-5aaf854e",
  • "status": "STARTING",
  • "currentBatch": 1,
  • "numOfBatches": 5,
  • "comment": "This is why I deployed my cluster.",
  • "progress":
    {
    },
  • "oceanId": "o-12e31234",
  • "instanceIds":
    [
    ],
  • "launchSpecIds":
    [
    ],
  • "createdAt": "2019-03-24T15:46:09.000Z",
  • "updatedAt": "2019-03-24T15:46:09.000Z"
}

Ocean AWS - List Of All Rolls

Get status for all rolls of an Ocean cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "status":
    {
    },
  • "kind": "spotinst:ocean:aws:k8s:cluster:roll",
  • "items":
    {
    }
}

Ocean AWS - Roll Update

Update a roll of an Ocean cluster.

Performing the request will stop the next batch in a roll

Authorizations:
SpotAuth
path Parameters
ROLL_ID
required
string
Example: scr-12345abc

Ocean Cluster Roll ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
object

Settings for roll operation

status
string

Set status to roll. Valid values: "STOPPED"

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "id": "scr-5aaf854e",
  • "status": "STARTING",
  • "currentBatch": 1,
  • "numOfBatches": 5,
  • "progress":
    {
    },
  • "oceanId": "o-12e31234",
  • "createdAt": "2019-03-24T15:46:09.000Z",
  • "updatedAt": "2019-03-24T15:46:09.000Z"
}

Ocean AWS - Get Roll

Get status for roll of an Ocean cluster.

Authorizations:
SpotAuth
path Parameters
ROLL_ID
required
string
Example: scr-12345abc

Ocean Cluster Roll ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "id": "scr-5aaf854e",
  • "status": "STARTING",
  • "currentBatch": 1,
  • "numOfBatches": 5,
  • "comment": "This is why I deployed my cluster.",
  • "progress":
    {
    },
  • "oceanId": "o-12e31234",
  • "instanceIds":
    [
    ],
  • "launchSpecIds":
    [
    ],
  • "createdAt": "2019-03-24T15:46:09.000Z",
  • "updatedAt": "2019-03-24T15:46:09.000Z"
}

Ocean AWS - Create Launch Specification

create launch specification cluster

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object (AWS Cluster)
object
object

Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.

object

Assign an Elastic IP to the instances spun by the launch spec. Can be null.

object (auto-scaler)

The instance profile iamRole object

imageId
string

Set image ID. Can be null

instanceTypes
array

A list of instance types allowed to be provisioned for pods pending for the launch specification. The list overrides the list defined for the Ocean cluster. Can be null.

object

Add labels to cluster

name
string

Set Launch Specification name

oceanId
required
string

The Ocean cluster ID. required for launchSpec create.

object
rootVolumeSize
integer

Set root volume size (in GB). This field and blockDeviceMappings cannot be used in the same spec.

securityGroupIds
array of string

Set security groups. Each element in array should be security group ID

subnetIds
array of string

Set subnets in launchSpec. Each element in array should be subnet ID

object

List of kay-value pairs of tags

object

Add taints to cluster

userData
string

Set user data script in Base64-encoded MIME

Responses

Request samples

Content type
application/json
{
  • "launchSpec":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Get All Launch Specifications

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Delete Launch Specification

Delete a specified launch specification in an Ocean cluster.

Authorizations:
SpotAuth
path Parameters
deleteNodes
boolean
Example: true

When set to "true", all instances belonging to the deleted launch specification will be drained, detached, and terminated.

OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Update Launch Specification

create launch specification cluster

Authorizations:
SpotAuth
path Parameters
autoApplyTags
boolean
Example: true

Ocean cluster launchSpec ID. Can get launchSpec ID with get call.

OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object (AWS Cluster)
object
object

Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.

object

Assign an Elastic IP to the instances spun by the launch spec. Can be null.

object (auto-scaler)

The instance profile iamRole object

imageId
string

Set image ID. Can be null

instanceTypes
array

A list of instance types allowed to be provisioned for pods pending for the launch specification. The list overrides the list defined for the Ocean cluster. Can be null.

object

Add labels to cluster

name
string

Set Launch Specification name

oceanId
required
string

The Ocean cluster ID. required for launchSpec create.

object
rootVolumeSize
integer

Set root volume size (in GB). This field and blockDeviceMappings cannot be used in the same spec.

securityGroupIds
array of string

Set security groups. Each element in array should be security group ID

subnetIds
array of string

Set subnets in launchSpec. Each element in array should be subnet ID

object

List of kay-value pairs of tags

object

Add taints to cluster

userData
string

Set user data script in Base64-encoded MIME

Responses

Request samples

Content type
application/json
{
  • "launchSpec":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Get A Launch Specification

Authorizations:
SpotAuth
path Parameters
OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean AWS - Import ASG To Ocean Cluster Launch Specification

This API creates an Ocean cluster launch specification configuration according to an AWS autoscaling group (ASG) configuration. By using the API, Create Launch Specification, you can then use the returned launch specification to create an actual Ocean launch specification. This API fetches an AWS ASG and converts it to a launch specification template. The response returned is an “imported” launch specification from the ASG in the required JSON format which you can then use in the Create Launch Specification API.

Authorizations:
SpotAuth
path Parameters
autoScalingGroupName
required
string

The ASG name.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "oceanId": "o-500a5d5a",
  • "name": "TestTeam1",
  • "imageId": "ami-0ce21b51cb55a48b8",
  • "securityGroupIds":
    [
    ],
  • "tags":
    {
    }
}

Ocean ECS

Ocean - Serverless containers for Amazon Elastic Container Service (ECS)

Ocean for ECS Concepts and Tutorials

Ocean ECS - Get All

Get the configurations for all Ocean cluster in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Create Cluster

Create a new Ocean ECS cluster in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object (ECS Ocean)
object (Ocean AutoScaler)

The Ocean Kubernetes Autoscaler.

object (Capacity Units)

Capacity specifications for the Ocean cluster.

clusterName
string

ECS cluster name

object (Ocean Compute)
name
string

Add a name for the Ocean cluster.

region
string

Select the region for the Ocean cluster to run in.

object (Ocean Scheduling)
object (Ocean Strategy)

Strategy Configuration of the Ocean cluster

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Get Cluster

Get the configurations for a specified Ocean cluster.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Update Cluster

All Ocean parameters are updatable, excluding the Region and ID. This API supports partial updates, so specific fields can be updated separately.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

autoApplyTags
boolean
Default: false
Example: autoApplyTags=true

Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json
required
object (ECS Ocean)
object (Ocean AutoScaler)

The Ocean Kubernetes Autoscaler.

object (Capacity Units)

Capacity specifications for the Ocean cluster.

clusterName
string

ECS cluster name

object (Ocean Compute)
name
string

Add a name for the Ocean cluster.

region
string

Select the region for the Ocean cluster to run in.

object (Ocean Scheduling)
object (Ocean Strategy)

Strategy Configuration of the Ocean cluster

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Delete Cluster

Delete a specified Ocean cluster.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Upgrade Elastigroup to Ocean

Upgrade an Elastigroup with ECS integration into Ocean for ECS cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

groupId
required
string
Example: groupId=sig-1234abcd

The Elastigroup ID to upgrade.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS Roll - Initiate Roll

Roll an entire Ocean cluster or roll subsets of the cluster by specifying launchSpecIds or instanceIds. Performing this request will start the roll immediately, by defined batches. Note that the first response for a successful request will notify for starting a roll. In order to check the status of a roll, you can use the GET Roll API using the roll ID.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
One of
batchSizePercentage
integer

Value in % to set size of batch in roll. Valid values are 0-100

comment
string

Add a comment description for the roll. comment should be limit to 256 chars.

Responses

Request samples

Content type
application/json
{
  • "batchSizePercentage": 20,
  • "comment": "This is why I deployed my cluster.",
  • "launchSpecIds":
    [
    ]
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS Roll - Get All Rolls

Get status for roll of an Ocean cluster.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS Roll - Update Roll

Update a roll of an Ocean cluster. Performing the request will stop the next batch in a roll.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

ROLL_ID
required
string
Example: scr-12345abc

Ocean Cluster Roll ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
comment
string

Add a comment description for the roll. comment should be limit to 256 chars.

status
string

Set status to roll.

Responses

Request samples

Content type
application/json
{
  • "status": "STOPPED",
  • "comment": "This is why I deployed my cluster."
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS Roll - Get Roll

Get status for roll of an Ocean cluster.

Authorizations:
SpotAuth
path Parameters
oceanClusterId
required
string
Example: o-12345abc

Ocean Cluster ID

ROLL_ID
required
string
Example: scr-12345abc

Ocean Cluster Roll ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Create Launch Specification

Create a new Ocean ECS LaunchSpecification in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
Array of objects

Add attributes to cluster

object
Array of objects

Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.

Array of arn (string) or name (string)

The instance profile iamRole object

imageId
string

Set image ID. Can be null

name
string

Set launch specifications name

oceanId
string

The Ocean cluster ID. required for launchSpec create.

securityGroupIds
Array of strings

Set security groups. Each element in array should be security group ID

subnetIds
Array of strings

Set subnets in launchSpec. Each element in the array should be a subnet ID.

Array of objects

List of kay-value pairs of tags

userData
string <byte>

Base64-encoded MIME user data to make available to the instances.

Responses

Request samples

Content type
application/json
{
  • "launchSpec":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Get All Launch Specifications

Get all the custom launch configurations for all Ocean cluster in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Get A Launch Specification

Get a specific custom launch configuration for an Ocean cluster in the specified account.

Authorizations:
SpotAuth
path Parameters
OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Delete Launch Specification

Delete a specified launch specification in an Ocean cluster.

Authorizations:
SpotAuth
path Parameters
OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

deleteContainerInstances
any
Example: deleteContainerInstances=true

When set to "true", all instances belonging to the deleted launch specification will be drained, detached, and terminated.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean ECS - Update A Launch Specification

Get a specific custom launch configuration for an Ocean cluster in the specified account.

Authorizations:
SpotAuth
path Parameters
OCEAN_LAUNCH_SPEC_ID
required
string

Ocean cluster launchSpec ID.

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

autoApplyTags
boolean
Default: false
Example: autoApplyTags=true

Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json
object
Array of objects

Add attributes to cluster

object
Array of objects

Block devices that are exposed to the instance. You can specify virtual devices and EBS volumes. This parameter and rootVolumeSize cannot be in the spec at the same time. This parameter can be null, but if not null, it must contain at least one block device.

Array of arn (string) or name (string)

The instance profile iamRole object

imageId
string

Set image ID. Can be null

name
string

Set launch specifications name

oceanId
string

The Ocean cluster ID. required for launchSpec create.

securityGroupIds
Array of strings

Set security groups. Each element in array should be security group ID

subnetIds
Array of strings

Set subnets in launchSpec. Each element in the array should be a subnet ID.

Array of objects

List of kay-value pairs of tags

userData
string <byte>

Base64-encoded MIME user data to make available to the instances.

Responses

Request samples

Content type
application/json
{
  • "launchSpec":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean GKE

Ocean - Serverless containers for for Google Kubernetes Engine

Ocean for GKE Concepts and Tutorials

Ocean On Premises

Ocean On-Premises API - Understand cost drivers within you on-premises clusters and compare the costs to the Ocean Cloud.

Ocean for On-Premises Concepts and Tutorials

Ocean On Premises - Create

Create a new Ocean On-Prem entity.
Prerequisites
The Spot Controller is used to monitor the cluster resources and report back to Ocean and is required for Ocean On-Prem. To install the Spot Controller, complete and run the following script on a machine with kubectl command line tool installed and configured:

  #!/usr/bin/env bash
  curl -fsSL http://spotinst-public.s3.amazonaws.com/integrations/kubernetes/cluster-controller/scripts/init.sh | \
  SPOTINST_TOKEN=<ENTER YOUR TOKEN HERE> \
  SPOTINST_ACCOUNT=<ENTER YOUR SPOTINST ACCOUNT ID HERE> \
  SPOTINST_CLUSTER_IDENTIFIER=<ENTER YOUR CLUSTER IDENTIFIER HERE> \
  bash


For more on the Spot controller and Ocean’s anatomy see the documentation here.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
controllerClusterIdentifier
required
string

The cluster Id where the Ocean controller is installed.

descriotion
string

Optionally provide a description.

name
required
string

The name of the cluster.

required
object (Price Per Unit)

Ocean will monitor the costs of each resource unit.

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    }
}

Response samples

Content type
application/json
{
  • "response":
    {
    }
}

Ocean On Premises - List

List the configurations for all Ocean cluster in the specified account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "response":
    {
    }
}

Ocean On Premises - Delete

Delete an Ocean On-Prem cluster entity in Spot Ocean. This DOES NOT affect your on-prem cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Ocean On Premises - Get

Get the configurations for the specified Ocean On-Prem cluster entity.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Responses

Response samples

Content type
application/json
{
  • "response":
    {
    }
}

Ocean On Premises - Update

All Ocean on-prem parameters are updatable. This API supports partial updates, so specific fields can be updated separately.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

OCEAN_ID
required
string
Example: OCEAN_ID=o-1abcd124

The ID of the Ocean cluster to delete.

Request Body schema: application/json
required
object (AWS Cluster)
group
object

Responses

Request samples

Content type
application/json
{
  • "cluster":
    {
    },
  • "group": { }
}

Response samples

Content type
application/json
{
  • "response":
    {
    }
}

Elastigroup AWS

Elastigroup for Amazon Web Services (AWS)

Elastigroup for AWS Concepts and Tutorials

Elastigroup AWS - Create

Create a new AWS Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object

Group

object (Capacity Object)

Capacity Object

object (Compute Object)

Compute Object

createdAt
string (Creation Time Indicator)

Creation Time Indicator

multai
string (Multai Indicator)

Mulati Indicator

name
string (Elastigroup Name)

Elastigroup Name

object (Scaling Object)

Scaling Object

scheduling
object (Scheduling Object)

Scheduling Object

object (Strategy object)

Strategy object

thirdPartiesIntegration
object (Third Parties Integration Object)

Third Parties Integration Object

updatedAt
string (Update Time Indicator)

Update Time Indicator

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - List

List all AWS Elastigroups for a Spot Account

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Update

Describe a specific Elastigroup JSON

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

autoApplyTags
boolean
Default: false
Example: autoApplyTags=true

Optionally update resource tags on the fly without performing a roll.

Request Body schema: application/json

API call accept several bodies, please choose

One of
object (group)
object (Capacity)
maximum
integer
Default: 0

Number that indicates minimum instance amount

minimum
integer
Default: 0

Number that indicates minimum instance amount

target
integer
Default: 0

Number that indicates amount of desired instances

Responses

Request samples

Content type
application/json
Example
Capacity Update
Capacity Update
AMI Update
Security Group Update
Nullify signal settings
Instance Type Selection Update
Metadata Options Update
Set Kubernetes Integration
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Delete

Delete an Elastigroup AWS

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object (AMI Dellocation Options)
object (Beanstalk Dellocation Options)
object (Stateful deallocation options)

Responses

Request samples

Content type
application/json
{
  • "statefulDeallocation":
    {
    },
  • "beanstalk":
    {
    },
  • "amiBackup":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - List Group

Describe a specific Elastigroup JSON

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Create Beanstalk Elastigroup

Create a beanstalk elastigroup with the following steps:

  • Get the beanstalk configuration to JSON format
  • Modify required parameters and post the JSON as a body to create a new elastigroup
Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object (Capacity Units)
object
description
string

The detailed purpose for this Elastigroup

name
required
string

The name of the Elastigroup

object
object
object

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful List Stateful Instances

List all stateful instances associated with the Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

AWS Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Pause Stateful Instance

Pause a stateful instance

Authorizations:
SpotAuth
path Parameters
groupId
required
string

AWS Elastigroup ID

statefulInstanceId
required
string

Stateful instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Resume Stateful Instance

Pause a stateful instance

Authorizations:
SpotAuth
path Parameters
groupId
required
string

AWS Elastigroup ID

statefulInstanceId
required
string

Stateful instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Recycle Stateful Instance

Recycle a stateful instance AWS

Authorizations:
SpotAuth
path Parameters
groupId
required
string

AWS Elastigroup ID

statefulInstanceId
required
string

Stateful instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful De-Allocate Stateful Instance

De-allocate a stateful instance – delete all the resources associated with the instance (network interface, snapshots, volumes)

Authorizations:
SpotAuth
path Parameters
groupId
required
string

AWS Elastigroup ID

statefulInstanceId
required
string

Stateful instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Import Stateful Instance

Create a new Stateful Elastigroup – this Elastigroup will have the same configuration and state of the imported instance.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
Array of objects

An Array holding an object of availabilityZones, this configures the availability zones the group may launch instances in. If this is not passed, the availability zone configuration is taken from the imported instance. Note: This field must be null if statefulMigrationGroup.shouldKeepPrivateIp is true, and must have a minimum of one availability zone.

name
required
string

Specify the new Elastigroup name.

originalInstanceId
required
string

The originating Instance ID. This instance will be imported along with its State.

product
string

Operation system type. Possible values: Linux/UNIX | SUSE | Linux Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC).

region
string

Specify the AWS Region the instance is running in and the new Elastigroup will be created in.

shouldTerminateInstance
Boolean

Decide if the instance termination should be automatic or manual. True = automatic termination. False = manual termination.

spotInstanceTypes
Array of strings

An Array holding the types of instances to be used in the Elastigroup.

Responses

Request samples

Content type
application/json
{
  • "statefulMigrationGroup":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Get Stateful Import Status

Get the current status of the import process. Possible values are:

  • MIGRATE_PREPARE_AWS_INSTANCE
  • MIGRATE_CREATE_IMAGE
  • MIGRATE_AWAIT_FOR_IMAGE
  • MIGRATE_AWAIT_USER_ACTION
  • MIGRATE_TERMINATE_INSTANCE
  • MIGRATE_AWAIT_INSTANCE_TERMINATION
  • MIGRATE_UPDATE_GROUP
  • MIGRATE_LAUNCH_INSTANCE
  • MIGRATE_AWAIT_INSTANCE_RUNNING
  • MIGRATE_RESUME_STATEFUL_INSTANCE
  • MIGRATE_AWAIT_STATEFUL_INSTANCE_RUNNING
  • MIGRATE_CANCEL
  • MIGRATE_FINISH
  • MIGRATE_ERROR

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

statefulMigrationGroupID
required
string
Example: statefulMigrationGroupID=smg-7f041234

The Process id you want to query

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Delete Stateful Import Status

Cancel the ongoing stateful import

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

statefulMigrationGroupID
required
string
Example: statefulMigrationGroupID=smg-7f041234

The Process id you want to delete

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Stateful Terminate Stateful Instance During Import Process

Manually terminate the source stateful instance during an stateful instance import.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

statefulMigrationGroupID
required
string

The Process id you want to terminate

Request Body schema: application/json
object
type
string

Valid values: "terminate"

Responses

Request samples

Content type
application/json
{
  • "userAction":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Instance Lock

Set termination protection for specific instance

Authorizations:
SpotAuth
path Parameters
instanceId
required
string
Example: i-123456

AWS Instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

ttl
string
Example: ttl=23

Specify a TTL (in minutes) for this lock, meaning, for how long the protection will be valid for

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Instance Unlock

Remove the termination protection from specific instance

Authorizations:
SpotAuth
path Parameters
instanceId
required
string
Example: i-123456

AWS Instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Status

Describes the current status of a specific Elastigroup – entailing information regarding running instance and their status

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Activity Events

Get historical data on events that happened in a specific Elastigroup like update, scaling activities, creation of new instances, etc.

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

startDate
required
string
Example: startDate=2016-10-01

Starting date to fetch the events from

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Get Log Entries

You can fetch a group’s (Elastigroup/Ocean/Managed Instance) elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back, so minimal fromDate should be up to 3 months back at runtime.

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

fromDate
required
string
Example: fromDate=1540036800000

Epoch number that represents the date from which to collect the log (millisecond format)

limit
string
Example: limit=i-12345678

Maximum number of lines to extract in a response. Max value allowed - 1000. Default: 500

resourceId
string
Example: resourceId=i-12345678

Filter log extracted entires related to a specific resource id. Default: Null

severity
string
Example: severity=all

Filter log extracted entires related to a specific resource id

toDate
required
string
Example: toDate=1542715200000

Epoch number that represents the date until which log is collected (millisecond format)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Update Capacity

Update the capacity of an Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object (Capacity)
maximum
integer
Default: 0

Number that indicates minimum instance amount

minimum
integer
Default: 0

Number that indicates minimum instance amount

target
integer
Default: 0

Number that indicates amount of desired instances

Responses

Request samples

Content type
application/json
{
  • "capacity":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Scale Up

Add instances to your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
integer
Example: adjustment=1

The number of instances to add to the Elastigroup

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Scale Down

Remove instances from your Elastigroup. Note - Scale Advanced expression Remove instances from your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
integer
Example: adjustment=1

The number of instances to add to the Elastigroup

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Suspend Scaling Policies

Suspend processes inside your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

policyName
required
string
Example: policyName=Example Policy Name

Policy Name of scaling policy to suspend

Request Body schema: application/json
object (Suspension)
ttlInMinutes
integer

Set TTL in minutes. min value: 1 (one minute). max value: 10080 (one week)

Responses

Request samples

Content type
application/json
{
  • "suspension":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Suspend Processes

Suspend processes inside your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
groupId
array

groupId

suspensions
array

Suspensions

Responses

Request samples

Content type
application/json
{
  • "groupId": "sig-12345",
  • "suspensions":
    [
    ]
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - List Suspended Processes

List all active Suspended processes for specific Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Remove Suspended Processes

Remove active suspension from Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
processes
array (Processes)

The list of processes to remove from suspension. Valid values are: AUTO_SCALE, AUTO_HEALING, OUT_OF_STRATEGY, PREVENTIVE_REPLACEMENT, REVERT_PREFERRED, SCHEDULING

Responses

Request samples

Content type
application/json
{
  • "processes":
    [
    ]
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - List Suspended Scaling Policies

Suspended scaling policies inside your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Remove Suspended Scaling Policies

Resume suspended scaling policies inside your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

policyName
string
Example: policyName=policy_1

Name of the suspended scaling policy to remove from suspension

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Potential Savings

Describe Potential Savings for AWS resources like - ASG (Auto-scaling groups), Beanstalk, ELB, ECS, EMR and tagged instances. The response will provide Potential monthly savings in USD

Authorizations:
SpotAuth
query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Instances Potential Savings

Describe potential savings for the listed instances. You can provide multiple instance IDs separated by a comma. The response will provide potential monthly savings in USD.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

instanceIds
required
string
Example: instanceIds=i-1234567

The instance ID

region
required
string
Example: region=us-east-1

The AWS Region

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS - Costs Per Account

Retrieve costs per specified account over a specified time period. Example of URL with with daily aggregation period over a time period of 30 days - https://api.spotinst.io/aws/ec2/account/costs?fromDate=1585699200000&toDate=1588291199000&aggregationPeriod=daily

Authorizations:
SpotAuth
query Parameters
accountId
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

aggregationPeriod
string
Example: aggregationPeriod=daily

Optional. The time period over which data is aggregated. Can only be "daily". For example, the figures in each data set are per day

fromDate
string
Example: fromDate=2018-06-20

Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).

toDate
string
Example: toDate=2018-11-20

Date can be either in ISO-8601 date format (yyyy-mm-dd) or in Unix Timestamp format (e.g. 1494751821472).

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Costs Per Elastigroup

Get financial information on a specific Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

aggregationPeriod
string
Example: aggregationPeriod=daily

Optional. The time period over which data is aggregated. Can only be "daily". For example, the figures in each data set are per day

fromDate
required
string
Example: fromDate=2018-06-20

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

toDate
required
string
Example: toDate=2018-11-20

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Detailed Cost

Get detailed financial information on a specific Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

fromDate
required
string
Example: fromDate=2018-06-20

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

toDate
required
string
Example: toDate=2018-11-20

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Instance Status

Get the current instance status Possible status values - Active and Terminating

Authorizations:
SpotAuth
path Parameters
insatnceId
required
string
Example: i-123456

The instance ID you want to query

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Import EC2 Instance

Import an EC2 instance into a new Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

instanceId
required
string
Example: instanceId=i-008a13360040aa88e

Enter the AWS instance Id of the instance to import

region
required
string
Example: region=us-east-2

The AWS region to create the new Elastigroup in

Request Body schema: application/json
object (Group)
name
string

The name of the new Elastigroup

spotInstanceTypes
array

Optionally provide a list of spot instance types to improve spot market availability for the Elastigroup. Overrides the imported instance type.

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - AMI Backup

Get status of a specific deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

Responses

AWS Elastigroup - Instance Healthiness

Get a list of instances with health status.

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Detach Instance

Detach instances from your Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Request Body schema: application/json
drainingTimeout
integer (Time)

Draining Timeout

instancesToDetach
object (Instances to be detached)

Instances to be detached

shouldDecrementTargetCapacity
boolean (Decrement target capacity criteria)

Should Decrement Target Capacity Criteria

shouldTerminateInstances
boolean (Termination criteria)

Should Terminate Instances Criteria

Responses

Request samples

Content type
application/json
{
  • "instancesToDetach":
    [
    ],
  • "shouldTerminateInstances": true,
  • "shouldDecrementTargetCapacity": false,
  • "drainingTimeout": 300
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Import ASG

Create a new Elastigroup – this Elastigroup will have the same configuration of the imported Autoscaling group

Authorizations:
SpotAuth
query Parameters
accountId
string
Example: accountId=act-12345

Your account id in Spot

asgName
required
string
Example: asgName=MyASG

The ASG name

dryRun
string
Example: dryRun=act-12345

When dryRun is set to true, the API call will return the Elastigroup configuration without actually performing any action

region
required
string
Example: region=us-east-1

The AWS region for the ASG

Request Body schema: application/json
object (Group)
name
object (Name)

Specify the actual auto scaling group name that the configuration will be imported from

product
string (Product (OS))

Operation system type. Possible values: Linux/UNIX | SUSE | Linux Windows | Linux/UNIX (Amazon VPC) | SUSE Linux (Amazon VPC) | Windows (Amazon VPC)

spotInstanceTypes
array (Product (OS))

An Array holding the types of instances to be used in the Elastigroup

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Instance Type By Region

Get the available spot instances types available in a specific region

Authorizations:
SpotAuth
query Parameters
region
required
string
Example: region=us-east-2

The AWS region

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Suggested Instance Type

Get suggested instance types by required resources. Note that request must include region, and at least one of the following values - baselineInstanceType, requiredVCpu, requiredMemoryGib

Authorizations:
SpotAuth
query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Request Body schema: application/json
object (AWS Elastigroup)
baselineInstanceType
string

Set valid AWS instance type as baseline

region
string

Set valid AWS region

object

Set required Memory (in Gib) resources by min / max

object

Set required CPU resources by min / max

Responses

Request samples

Content type
application/json
{
  • "requirements":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Simulate An Instance Interruption

The simulate instance interruption API is used for simulating a spot interruption in AWS, so that customers can verify specific applicative behaviors in case an interruption takes place. Once the interruption api is called, instances posted in the API body will be terminated in AWS, thus mocking a spot interruption.

Authorizations:
SpotAuth
query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Request Body schema: application/json
instancesToInterrupt
string

A list of group's instance ids to interrupt

Responses

Request samples

Content type
application/json
{
  • "instancesToInterrupt":
    [
    ]
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Create Instance Signal

The instance signal API is used for notifying Spot about the instance state, so Spot can act accordingly. Supported signals are - INSTANCE_READY – Whenever this signal is sent, Spot will register the instance to the ELB INSTANCE_READY_TO_SHUTDOWN – Whenever this signal is sent, Spot will terminate the instance after it was marked for termination. Important - You need to define the expected signals for your Elastigroup in the group configuration.

Authorizations:
SpotAuth
path Parameters
insatnceId
required
string
Example: i-123456

The instance ID you want to query

signal
required
string
Example: INSTANCE_READY

The specific signal you want to trigger. Valid Values: INSTANCE_READY, INSTANCE_READY_TO_SHUTDOWN

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Request Body schema: application/json
instanceId
string

The instance ID the signal refers to.

signal
string

The specific signal you want to trigger. Valid Values - INSTANCE_READY, INSTANCE_READY_TO_SHUTDOWN

Responses

Request samples

Content type
application/json
{
  • "instanceId": "i-123456",
  • "signal": "INSTANCE_READY"
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Instance Standby

Instance Standby enables you to put an instance in Standby state , update or troubleshoot the instance, and then return the instance to service. Instances that are on standby are still part of the Elastigroup, but they don’t get application traffic. Whenever instance is standby state - It will be de-registered from all the ELBs / ALBs in the Elastigroup It won’t be affected from Scale down activities in the Elastigroup The instance health won’t be checked, and it won’t be replaced When the instance exits the Standby state - The instance will be register back to all the ELBs / ALBs that are defined in the Elastigroup It will be considered and affected from all the Elastigroup activities (helth checks, scaling, etc.)

Authorizations:
SpotAuth
path Parameters
instanceId
required
string
Example: i-123456

The instance ID you want to put in standby state

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Exit Instance Standby

Exit standby by mode

Authorizations:
SpotAuth
path Parameters
instanceId
required
string
Example: i-123456

The instance ID you want to put in standby state

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Group's Deployments Status

Get list of all the deployments of a specific Elastigroup and their status

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

limit
integer
Example: limit=5

Limits results

sort
string
Example: sort=createdAt:ASC

Field to sort by the results Default: createdAt:DESC

Request Body schema: application/json
batchSizePercentage
integer (Batch size percentage indicator)

Indicates (in percentage) the batch size of the deployment (meaning, how many instances to replace in each batch)

gracePeriod
integer (Grace period indicator)

Indicates (in seconds) the timeout to wait until instance become healthy based on the healthCheckType

healthCheckType
string (Health check type indicator)

Define a health check type. valid values: ELB, ECS_CLUSTER_INSTANCE, TARGET_GROUP, OPSWORKS, NOMAD_NODE, MULTAI_TARGET_SET, HCS, EC2, NONE (wait the entire grace period for each batch). If no value is set the roll will use the group’s auto-healing health check.

object (Strategy)

The roll strategy

Responses

Request samples

Content type
application/json
{
  • "batchSizePercentage": 20,
  • "gracePeriod": 300,
  • "healthCheckType": "EC2",
  • "strategy":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Deploy

Deploy your Elastigroup (triggers Blue/Green Deployment that replaces the existing instances in the Elastigroup)

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Stop Deployment

Stop an existing deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

rollId
required
string
Example: sbgd-9876

The deployment id you want to stop

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Request Body schema: application/json
object (Role)
status
string (Status)

Set the status of the group to “STOPPED"

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Deploy Status

Get status of a specific deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

rollId
required
string
Example: sbgd-9876

The deployment id you want to query

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

AWS Elastigroup - Deployment Actions

Apply a Detach action to a deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string
Example: sig-12345

The Spot Elastigroup id you want to update

query Parameters
accountId
string
Example: accountId=act-123abc

Your Spot accountId associated with your token

rollId
required
string
Example: rollId=sbgd-9876

The deployment id you want to stop

Request Body schema: application/json
actionType
string (Type of action)

Sets the action that will take place, Accepted values are: DETACH_OLD, DETACH_NEW

drainingTimeout
integer (Draining timeout criteria)

Indicates (in seconds) the timeout to wait until instance are detached

shouldDecrementTargetCapacity
boolean (Should Decrement Target Capacity criteria)
Default: true
shouldHandleAllBatches
boolean (Should Hnadle All Batches Criteria)
Default: false

Indicator if the action should apply to all batches of the deployment or only the latest batch

Responses

Request samples

Content type
application/json
{
  • "actionType": "DETACH_NEW",
  • "shouldHandleAllBatches": true,
  • "drainingTimeout": 200,
  • "shouldDecrementTargetCapacity": true
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - ECS Initiate Cluster Roll

Initiate a cluster roll for an Elastigroup with ECS cluster

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
batchSizePercentage
required
integer

Size of patch for roll as a percent

comment
string

Add a comment description for the roll. comment should be limit to 256 chars.

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - ECS Update Cluster Roll Status

Update a running ECS cluster roll status

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
status
required
string

Valid values: "STOPPED"

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - ECS Get All Cluster Rolls Per Elastigroup

Get status for every ECS cluster rolls in given Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - ECS Get Cluster Roll Status By Roll ID

Get status for specific ECS cluster rolls in given Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

ROLL_ID
required
string

The cluster roll ID you want to query

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Start Beanstalk Maintenance

Put your Beanstslk elastigroup into maintenance mode, before you start updating the beanstalk configuration.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Finish Beanstalk Maintenance

Finish maintenance mode, and trigger a blue-green deployment.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Get Beanstalk Maintenance Status

Get the group maintenance status.

  • If the status is ACTIVE: putting the group in maintenance mode is allowed.
  • If the status is AWAIT_USER_UPDATE: the group is pending for manually finishing maintenance mode.
  • If the status is CANCELING_MAINTENANCE_MODE: the group is in the process of canceling maintenance mode.
Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Get Beanstalk Configuration

  • Get your Beanstalk environment configuration from AWS. This call is typically used as the initial step in importing your existing Beanstalk configuration to an Elastigroup.
  • Note: To optimize the availability of your Beanstalk workload on Elastigroup, instance types similar to those running in your existing configuration are automatically added to the response under instanceTypes. Should these instance types not meet your requirements you may remove them.
Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

ENVIRONMENT_ID
required
string
Example: ENVIRONMENT_ID=e-12345

The ASG name

REGION
required
string
Example: REGION=us-east-1

The AWS region for the ASG

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Beanstalk ReImport

Re-import the beanstalk configuration

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Create CodeDeploy B/G Deployment

Trigger a Blue-Green deployment to your Elastigroup, this will initiate a deployment that will replace the existing instances(blue) with new ones(green).

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
Array of objects
Array of objects
timeout
integer

Responses

Request samples

Content type
application/json
{
  • "deployment":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup AWS - Get CodeDeploy B/G Deployment

Get CodeDeploy Elastigroup deployment status for more information see: CodeDeploy B/G Deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
Array of objects
Array of objects
timeout
integer

Responses

Request samples

Content type
application/json
{
  • "deployment":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS

Managed Instances are Spot’s solution for launching and managing a single compute instance. On the AWS cloud, for a standard single instance workload, an On-Demand EC2 instance is launched. The instance is expected to be highly available, easily manageable, and integrate well with additional services and monitoring tools. For more information please review the concepts section.

Managed Instance for AWS Concepts and Tutorials

Managed Instance AWS - Create

Create a new Managed Instance resource.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
object (MI Compute)
description
string

Describe your Managed Instance resource

object
object (MI integrations)
name
string

Managed Instance name

object

Persistence settings. Should omit at least one of the persist options below.

region
string

The AWS region your resource will be created in.

object (MI Scheduling)
object (MI Strategy)

Responses

Request samples

Content type
application/json
{
  • "managedInstance":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Get All

Get all Managed Instance resources in the account.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Update

  • Update one or more attributes in your Managed Instance.
  • This API supports partial updates, so only specific fields can be updated separately.
  • In order to remove a setting from the instance config, set the object value to null.
  • For a Full List of the Elastigroup JSON object reference please see Managed Instance Create.
Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Get

Get specific Managed Instance config.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Delete

Get specific Managed Instance config.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Request Body schema: application/json
object
object

Responses

Request samples

Content type
application/json
{
  • "deallocationConfig":
    {
    },
  • "amiBackup":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Pause

Pause an existing Managed Instance.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Resume

Resume an existing Managed Instance.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Recycle

Recycle an existing Managed Instance.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Costs Per Managed Instance

Get financial information on a specific managed instance. To use this API, managedInstanceId must be defined.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

aggregationPeriod
string

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

fromDate
required
string

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

toDATE
required
string

Data values following either a date format (YYYY-MM-DDTHH:mm:ss.SSSZ ; 2016-01-10T00:00:00.000Z) or Unix seconds Timestamp (1494751821)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Status

Describes the current status of a specific Managed Instance – entailing information regarding running instance and its status.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Import Instance From AWS

  • Import an instance from AWS into Managed Instance, while keeping the instance data and its persistence settings.
  • This call is starting the migration and returns migration ID.
  • In order to get migration status use the Get Migration Status call
Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
availabilityZones
Array of strings

List of availability zones for the Managed Instance. Should exist only if shouldKeepPrivateIp is false.

managedInstanceName
string

Set Managed Instance name

originalInstanceId
string

The instance ID on AWS

product
string

Set instance's product

region
string

Set instance's region

shouldKeepPrivateIp
boolean

Set whether the instance should keep its private ip or not

shouldTerminateInstance
boolean

Set true or false whether to terminate the instance in AWS. Note: If shouldKeepPrivateIp is true, then shouldTerminateInstance must be true. Otherwise an error will be returned.

spotInstanceTypes
Array of strings

List of possible instance types for the Managed Instance

Responses

Request samples

Content type
application/json
{
  • "migration":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Managed Instance AWS - Get Instance Migration Status

  • Get a previously initiated instance migration status.
  • To initiate an instance migration from AWS use the Import Instance From AWS call.
  • On initiation, the migration would be in the following state: “MIGRATE_START”.
  • Possible end states for the migration are: “MIGRATE_CANCEL”, “MIGRATE_FINISH”, “MIGRATE_ERROR”.
Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

MI_ID
required
string
Example: MI_ID=smi-111

Managed Instance id you want to get

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler

AWS EMR Scaler

AWS EMR Scaler Concepts and Tutorials

EMR Scaler - List

List all MR Scalers and their configuration.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Create

Create a new EMR cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object (EMR Cluster Object)

Allowed only when the new strategy is chosen.

object (Compute Object)

describes the compute resources for the MR scaler

description
string

description for the MRScaler

name
required
string

MRScaler name

region
required
string

The region of the source cluster

object (Scaling Object)

Set scaling polices.

object (Scheduling Object)

Schedule tasks to execute on the Elastigroup.

required
object (Strategy Object)

The strategy for creating the group. At least one of wrapping, cloning, or new is required.

Array of objects (Termination Policy Object)

Termination policies for EMR clusters based on CloudWatch Metrics.

Responses

Request samples

Content type
application/json
{
  • "mrScaler":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Get

Get a description of a specific MR Scaler and its configuration.

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Update

Update an MR Scaler. Partial updating is supported.

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
One of
object

MR Scaler Object - Update Task Capacity

object
object
object
object
maximum
integer
minimum
integer
target
integer

Responses

Request samples

Content type
application/json
{
  • "mrScaler":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Delete

Delete an MR Scaler

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - List Instances

Get a list of all instances and instances groups in the cluster

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Scale Up

Scale up MR Scaler instances

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
any
Example: adjustment=3

Number of instances to add to the MR Scaler

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Scale Down

Scale down MR Scaler instances

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
any
Example: adjustment=3

Number of instances to remove from the MR Scaler

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - List All Clusters

Get a list of all MR Scaler clusters

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

EMR Scaler - Costs

Get financial information on the MR Scaler, including running time, costs, and savings

Authorizations:
SpotAuth
path Parameters
MrScalerId
required
string
Example: simrs-12223

The MRScaler ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

required
string or string
Example: fromDate=2020-09-01 or fromDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

required
string or string
Example: toDate=2020-09-01 or toDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure

Elastigroup for Microsoft Azure

Elastigroup for Azure Concepts and Tutorials

Elastigroup Azure - Update

Update an Azure Elastigroup cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
required
object
required
object
object
name
required
string

Azure Elastigroup Name

region
required
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
required
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
required
object (Scaling Strategy)

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Get Group

List an Elastigroup cluster.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Delete

Delete an Elastigroup cluster.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Create

Create a new Elastigroup cluster.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object (Azure Elastigroup)
required
object
required
object
object
name
required
string

Azure Elastigroup Name

region
required
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
required
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
required
object (Scaling Strategy)

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - List All Groups

List Elastigroup clusters.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

NAME
string
Example: NAME=name

Filters to find the elastigroup via a specific name.

REGION
string
Example: REGION=region

Filters to find all the groups in a specific region.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Get Status

Get status of Elastigroup cluster.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Scale Down

Scale down virtual machines in Elastigroup cluster.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
integer
Example: adjustment=5

Number of VMs to scale down

Request Body schema: application/json
object
drainingTimeout
string

The time in seconds to allow the virtual machine be be drained from incoming TCP connections and detached from MLB before terminating it. Default: 300

shouldDecrementTargetCapacity
required
Boolean

Prevent Elastigroup from scaling back to target capacity when virtual machines are detached.

shouldTerminateVirtualMachines
required
Boolean

Indicates whether to terminate the VMs or not

virtualMachinesToDetach
required
Array of strings

Names of virtual machines to detach. Not empty.

Responses

Request samples

Content type
application/json
{
  • "scale":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Scale Up

Scale up virtual machines in Elastigroup cluster.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
integer
Example: adjustment=5

Number of VMs to scale up

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Create Deployment

Deploy the Elastigroup. This triggers a Blue/Green deployment that replaces the existing VMs in the Elastigroup.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
batchMinHealthyPercentage
integer

Indicates the threshold of minimum healthy virtual machines in a single batch. If the amount of healthy virtual machines in a single batch is under the threshold, the deployment will fail. If exists, the parameter value will be in the range of 1-100. In case of null as value, the default value in the backend will be 50%. The value of the parameter should represent the number in percentage (%) of the batch. Default: 50

batchSizePercentage
required
integer

Indicates (in percentage) the batch size of the deployment (meaning, how many nodes to replace in each batch). Valid values: 1-100. Cannot be null. Default: 25

drainingTimeout
integer

Indicates (in seconds) the timeout to drain the instances. Minimum 0. Can be null. Default: The Elastigroups draining time out or 120.

gracePeriod
integer

Indicates (in seconds) the timeout to wait until the node becomes healthy. Must be at least 300. Default: 600

healthCheckTypes
string

Define a health check type. Valid values: "vmState", "applicationGateway". Can be null. If no value is set, the deployment will use the group’s auto-healing health check.

Responses

Request samples

Content type
application/json
{
  • "deployment":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - List Group Deployments

Deploy the Elastigroup. This triggers a Blue/Green deployment that replaces the existing VMs in the Elastigroup.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

LIMIT
integer
Example: LIMIT=14

Limits the number of deployments returned. Default: 5

SORT
string
Example: SORT=createdAt:DESC

Field by which to sort the results. Default: createdAt:DESC

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Deployment Status

Get the status of a specific deployment.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

DEPLOYMENT_ID
required
string
Example: DEPLOYMENT_ID=sbgd-9876

The deployment ID you want to query.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Deployment Status Details

Get the detailed status of a specific deployment. This includes status details per batch and other information.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

DEPLOYMENT_ID
required
string
Example: DEPLOYMENT_ID=sbgd-9876

The deployment ID you want to query.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Create VM Signal

CThe VM signal API is used for notifying Spot about the VM state so that Spot can act accordingly. Supported signals are vmReady – Whenever this signal is sent, Spot will register the instance to the relevant Load Balancer and Application Gateway. vmReadyToShutdown – When this signal is received after a vm is detached; we will immediately terminate the vm. You must define the expected signals for your Elastigroup in the group configuration.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
signalType
required
String
Enum: "vmReady" "vmReadyToShutdown"

The specific signal you want to trigger.

vmName
required
string

The virtual machine ID the signal refers to.

Responses

Request samples

Content type
application/json
{
  • "signal":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure - Get Elastigroup Log Entries From Group

You can fetch a Elastigroup’s elastilog via the Spot API, in order to be able to consume elastilog from various tools used for log storing and analyzing. Logs have retention of 3 months back, so minimal fromDate should be up to 3 months back at runtime.

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

FROM_DATE
required
string
Example: FROM_DATE=1540036800000

Epoch number that represents the date from which to collect the log (millisecond format)

LIMIT
string
Example: LIMIT=500

Maximum number of lines to extract in a response. Max value allowed - 1000.

RESOURCE_ID
string
Example: RESOURCE_ID=vm-12345678

Filter log extracted entires related to a specific resource id Default: Null

SEVERITY
string
Example: SEVERITY=ALL

Severity of log entries to extract. Valid Values: ALL, INFO,DEBUG,WARN Default: ALL

TO_DATE
required
string
Example: TO_DATE=1542715200000

Epoch number that represents the date until which log is collected (millisecond format)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets

Elastigroup for Microsoft Azure

Elastigroup for Azure Scale Sets Concepts and Tutorials

Elastigroup Azure Scale Sets - List

List all Azure Elastigroups for a Spot Account

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Create

Create a new Azure Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
required
object
required
object
name
required
string

Azure Elastigroup Name

region
required
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
required
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
required
object (Scaling Strategy)
object

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Delete

Delete an Elastigroup Azure

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Describe

List all properties for single Azure Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Update

Update an Azure Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object
object
name
string

Azure Elastigroup Name

region
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
object (Scaling Strategy)
object

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Get Status

Get the status for all instances that are memebers of the Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Detach Instances

Detach one or more instances from an Azure Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
drainingTimeout
integer
instancesToDetach
Array of strings
shouldDecrementTargetCapacity
boolean

Responses

Request samples

Content type
application/json
{
  • "instancesToDetach":
    [
    ],
  • "shouldDecrementTargetCapacity": true,
  • "drainingTimeout": 300
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Task List

List all Azure Tasks for a Spot Account

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Task Create

Create a new Azure Task

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object
object
name
required
string

Azure Elastigroup Name

region
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
object (Scaling Strategy)
object

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Task Delete

Delete an Elastigroup Azure

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Scale Sets - Task Update

Update an Elastigroup Azure

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
object
object
name
required
string

Azure Elastigroup Name

region
string

Valid Azure region the Elastigroup is managed in

resourceGroupName
string

The Azure resource group to associate the elastigroup with

object (Azure Scaling)
object (Scaling Strategy)
object

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Deployment

Deployments for Elastigroup on Microsoft Azure

Elastigroup for Azure Deployments Concepts and Tutorials

Elastigroup Azure Deployment - Deployment List

Historical list of all deployments for an Azure Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Deployment - Start Deployment

Start a new Azure Elastigroup deployment

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Deployment - Describe Deployment

Describe a single deployment for an Azure Elastigroup

Authorizations:
SpotAuth
path Parameters
deploymentId
required
string
Example: sbgd-9876

Azure Elastigroup ID

groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup Azure Deployment - Stop Deployment

Stop a deployment

Authorizations:
SpotAuth
path Parameters
deploymentId
required
string
Example: sbgd-9876

Azure Elastigroup ID

groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP

Elastigroup for Google Cloud

Elastigroup for Google Cloud Concepts and Tutorials

Elastigroup GCP - List

List all GCP Elastigroups for a Spot Account

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Create

Create a new GCP Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
required
object (Capacity Units)
required
object (Compute Object)
createdAt
string <date-time>

The datetime the group was created.

description
string

Description for your GCP Elastigroup

name
required
string

GCP Elastigroup Name

object (Scaling object)
object (Scheduling Object)
required
object (Elastigroup Strategy)
object (Third Parties Integration Object)
updatedAt
string <date-time>

The datetime the group was last updated.

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Describe

List all properties for single GCP Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Delete

Delete an Elastigroup GCP

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Update

Update an GCP Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
required
object
required
object (Capacity Units)
required
object (Compute Object)
createdAt
string <date-time>

The datetime the group was created.

description
string

Description for your GCP Elastigroup

name
string

GCP Elastigroup Name

object (Scaling object)
object (Scheduling Object)
object (Elastigroup Strategy)
object (Third Parties Integration Object)
updatedAt
string <date-time>

The datetime the group was last updated.

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Import GKE Cluster

Import an existing GKE cluster to Elastigroup.

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

clusterId
required
string
Example: clusterId=myGKECluster

The GKE Cluster identifier

clusterLocation
required
string
Example: clusterLocation=us-central1-a

The location of the cluster. Enter the desired zone for zonal GKE clusters or the region for regional GKE clusters.

nodePoolName
string
Example: nodePoolName=somePoolName

Set the node pool to import

Request Body schema: application/json
required
object
availabilityZones
Array of strings

Availability Zone pool to be use for this group

object

Minimum, maximum and target number of vms in the Elastigroup

object

Types and locations of VMs to be utilized

name
string

Name of the Elastigroup

preemptiblePercentage
integer
Default: 100

Preemptive VMs ratio in the Elastigroup

Responses

Request samples

Content type
application/json
{
  • "group":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Get Status

Get the status for all instances that are memebers of the Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - List Activity Events

Get all activity events for the Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Fetch Elastilog

Fetch a group’s Elastilog

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

required
string or string
Example: fromDate=2020-09-01 or fromDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

limit
integer <= 1000
Default: 500
Example: limit=200

Maximum number of items to return.

required
string or string
Example: toDate=2020-09-01 or toDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Scale Up

Add instances to the Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
integer
Example: adjustment=1

The number of instances to add to the group

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Scale Down

Remove instances from the Elastigroup

Authorizations:
SpotAuth
query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

adjustment
required
integer
Example: adjustment=1

The number of instances to remove from the group

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Costs

Get financial information on a specific Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

required
string or string
Example: fromDate=2020-09-01 or fromDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

required
string or string
Example: toDate=2020-09-01 or toDate=1598918400000

Get items on or after this date (ISO 8601 or Unix timestamp)

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Detach Instances

Detach instances from an Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
drainingTimeout
integer

(Applies only if shouldTerminateInstances is on) The draining timeout (in seconds) before terminating the instance. If no draining timeout is defined, the group’s draining timeout applies.

instancesToDetach
array

The names of the instances to detach from the group.

shouldDecrementTargetCapacity
boolean

Indicates whether to decrement the capacity of the group, so no new instance will be launched instead of the detached one.

shouldTerminateInstances
boolean

Indicates whether to terminate the instances or not.

Responses

Request samples

Content type
application/json
{
  • "instancesToDetach":
    [
    ],
  • "shouldTerminateInstances": true,
  • "shouldDecrementTargetCapacity": true,
  • "drainingTimeout": 0
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Instance Status

Get the current instance status. Possible status values: ACTIVE, TERMINATING

Authorizations:
SpotAuth
path Parameters
instanceId
required
string

GCP Instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Lock Instance

Set termination protection for a specific instance.

Authorizations:
SpotAuth
path Parameters
instanceId
required
string

GCP Instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

ttlInMinutes
required
string

Specify a TTL (in minutes) for this lock, i.e.: for how long the protection will be valid for.

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP - Unlock Instance

Remove termination protection for a specific instance.

Authorizations:
SpotAuth
path Parameters
instanceId
required
string

GCP Instance ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP Deployment

Elastigroup GCP Deployment - List

Get all of the deployments for a specific Elastigroup, and their status

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
batchSizePercentage
required
integer

(in percentage) the batch size of the deployment, i.e.: how many instances to replace in each batch

gracePeriod
required
integer

(in seconds) the time until an instance becomes healthy in the load balancer

Responses

Request samples

Content type
application/json
{
  • "batchSizePercentage": 20,
  • "gracePeriod": 300
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP Deployment

Deploy the Elastigroup: Triggers a Blue/Green deployment that replaces the existing instances in the Elastigroup

Authorizations:
SpotAuth
path Parameters
groupId
required
string

Azure Elastigroup ID

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
batchSizePercentage
required
integer

(in percentage) the batch size of the deployment, i.e.: how many instances to replace in each batch

gracePeriod
required
integer

(in seconds) the time until an instance becomes healthy in the load balancer

Responses

Request samples

Content type
application/json
{
  • "batchSizePercentage": 20,
  • "gracePeriod": 300
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP Deployment - Status

Get a specific deployment's status

Authorizations:
SpotAuth
path Parameters
rollId
required
string

The deployment ID to query

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Responses

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}

Elastigroup GCP Deployment - Stop

Stop an existing deployment

Authorizations:
SpotAuth
path Parameters
rollId
required
string

The deployment ID to query

query Parameters
accountId
required
string
Example: accountId=act-123456789

Your Spot accountId associated with your token

Request Body schema: application/json
object
status
string

in this case, always set to "STOPPED"

Responses

Request samples

Content type
application/json
{
  • "roll":
    {
    }
}

Response samples

Content type
application/json
{
  • "request":
    {
    },
  • "response":
    {
    }
}